Introdução à API de pedidos

A API de Pedidos foi criada com o objetivo de automatizar e simplificar a criação de pedidos.

Trabalhamos com a persistência de clientes e produtos, o que torna o processo de geração de pedidos ainda mais eficiente.

Esta documentação foi elaborada para fornecer uma visão clara e completa de todos os recursos disponíveis. Em caso de dúvidas, entre em contato com nosso suporte.

Padronização

A API segue os padrões REST, utiliza o charset UTF-8 e o formato JSON para troca de mensagens (requisições e respostas).

Tecnologias utilizadas

Tecnologia	Descrição
REST	Modelo arquitetural baseado em restrições aplicadas a componentes e dados em sistemas distribuídos.
UTF-8	Codificação Unicode compatível com ASCII, capaz de representar qualquer caractere.
JSON	Formato leve de dados, utilizado para comunicação entre aplicações.

Verbos HTTP

A API utiliza os quatro principais verbos do protocolo HTTP:

Verbo	Objetivo
GET	Recupera informações de um recurso. Exemplo: listar clientes ou pedidos.
POST	Cria uma nova instância de recurso. Exemplo: cadastrar cliente ou pedido.
PUT	Atualiza informações de um recurso existente. Exemplo: editar endereço ou produto.
DELETE	Remove uma instância de recurso. Exemplo: excluir cliente ou produto.

Segurança

Todas as requisições devem ser autenticadas via Token, garantindo a segurança das informações de cada empresa.

O Token é gerado no painel do sistema, na aba "Integração > Meus Dados". Empresas administradoras também podem gerar Tokens para empresas vinculadas.

Cabeçalhos obrigatórios

Authorization: Token {token_da_empresa}
Content-Type: application/json

Após configurar os cabeçalhos, defina a URI da requisição, escolha o verbo HTTP, envie o conteúdo necessário (quando aplicável) e analise a resposta recebida.

Recursos

Abaixo está o endpoint base da API:

https://api.mysebr.com.br/pedido-api/rest/

A documentação completa dos recursos como clientes, produtos e pedidos está disponível nas seções específicas do menu lateral.

Status de retorno

Código	Descrição
001	Sucesso na operação do registro.
002	Documento pendente de processamento.
003	Documento faturado no sistema.
004	Documento faturado com nota fiscal gerada.
005	Sucesso na busca dos registros.
010	Documento cancelado no sistema.
999	Erro interno ao processar o registro.